v1.23.8

1.23.8 - 2025-02-20

This is a point release for Detekt 1.23.0, built against Kotlin 2.0.21, with fixes for several bugs that got reported by the community.

Notable Changes

• fix(deps): Update kotlin to 2.0.21 - #​7580
• fix(deps): Update AGP to v8.8.1 - #​7879
• fix(deps): update Gradle to v8.12.1 - #​7780

Changelog

• UseDataClass: do not report on expect classes - #​7857
• Fix InjectDispatcher false positives - #​7797
• [UnnecessaryParentheses] Allow float/double without integer part - #​7751
• Fix ThrowingExceptionsWithoutMessageOrCause false positive - #​7715
• Issue #​7634: Make UndocumentedPublicClass configurable to flag `com… - #​7635
• Fix redundant empty tags in baseline XML - #​7625
• MatchingDeclarationName now supports platofrm suffixes - #​6426

Contributors

We would like to thank the following contributors that made this release possible: @​BraisGabin, @​JordanLongstaff, @​Nava2, @​atulgpt, @​eygraber, @​lexa-diky, @​t-kameyama

v1.23.7

1.23.7 - 2024-09-08

This is a point release for Detekt 1.23.0, built against Kotlin 2.0.10, with fixes for several bugs that got reported by the community.

Notable Changes

• fix(deps): update kotlin monorepo to v2.0.10 - #​7517
• Update to Kotlin 2.0.0 #​6640
• fix(deps): update kotlin monorepo to v1.9.24 - #​7264
• fix(deps): update dependency com.android.tools.build:gradle to v8.5.2 - #​7525
• chore(deps): update dependency gradle to v8.10 - #​7546

Changelog

• Add basic support for isolated projects to 1.x - #​7526
• ExplicitCollectionElementAccessMethod: fix false positive when Map put has 3 arguments - #​7563
• BracesOnIfStatements: fix false-positive when chained - #​7444
• Add enum entry check in UndocumentedPublicProperty - #​7426
• Use the anchor which is already present before - #​7423
• Fix small corner-case in "SerialVersionUIDInSerializableClass" rule, … - #​7346
• SwallowedException: fix false positive when exception is used as a receiver - #​7288
• NamedArguments: fix false positive on spread varargs - #​7283
• MultilineLambdaItParameter: fix false negative with single statement on multiple lines - #​7221
• Check for root of receiver in selector expression - #​7220
• Check for public companion object for UndocumentedPublicClass - #​7219
• fix: TopLevelPropertyNaming also detecting extension property name - #​7212
• Publish detekt-compiler-plugin-all to Maven and GH Releases - #​7179
• versioned default detekt config file link - #​7161
• Support rangeUntil operator for UnusedImport rule - #​7104
• Fix false positive on it usages when type parameter is specified - #​6850

Housekeeping/Docs

• [bugfix] AnnotationOnSeparateLine in snippets - #​6526
• Add docs about using the Compiler Plugin with the Kotlin CLI compiler - #​7184

v1.9.0

==================

This release updates Kotlin version to 2.2.0, includes several bugfixes and provides serializers for kotlin.time.Instant.

Add kotlin.time.Instant serializers

Instant class was moved from kotlinx-datetime library to Kotlin standard library.
As a result, kotlinx-datetime 0.7.0 no longer has serializers for the Instant class.
To use new kotlin.time.Instant class in your @​Serializable classes,
you can use this 1.9.0 kotlinx-serialization version (Kotlin 2.2 is required).
You can choose between default InstantSerializer which uses its string representation,
or specify InstantComponentSerializer that represents instant as its components.
See details in the PR.

Other bugfixes

• Fix resize in JsonPath (#​2995)
• Fixed proguard rules for obfuscation to work correctly (#​2983)

v1.8.1

==================

This release updates Kotlin version to 2.1.20, while also providing several important improvements
and bugfixes.

Improvements

• Implemented encoding null in key and value of a map in Protobuf (#​2910)
• Make type argument in JsonTransformingSerializer nullable (#​2911)
• Use SPDX identifier in POMs (#​2936) (thanks to Leon Linhart)
• Add watchosDeviceArm64 to Okio integration module (#​2920) (thanks to Daniel Santiago)
• Update kotlinx-io version to 0.6.0 (#​2933) (thanks to Piotr Krzemiński)

Bugfixes

• Fix incorrect enum coercion during deserialization from JsonElement (#​2962)
• Supply proper equals(), hashCode(), and toString() for SerialDescriptor() wrapper (#​2942)
• Do not encode empty packed collections in protobuf (#​2907)

v1.8.0

==================

This release contains all of the changes from 1.8.0-RC. Kotlin 2.1.0 is used as a default, while upcoming 2.1.10 is also supported.
Also added small bugfixes, including speedup of ProtoWireType.from (#​2879).

v1.7.3

==================

This release aims to fix important issues that were discovered in the 1.7.2 release,
including the inability to sync certain projects into Android Studio/IntelliJ IDEA and exceptions from custom Uuid serializers.

It uses Kotlin 2.0.20 by default.

• Use explicit kotlin-stdlib and kotlin-test versions from version catalog (#​2818)
• Drop usage of deprecated Any?.freeze() in K/N target (#​2819)
• Check against serialName instead of simpleClassName (#​2802)
• Ignore NoClassDefFoundError when initializing builtins map for serializer() function (#​2803)
• Clarify example for SerializationException (#​2806)

v1.7.2

==================

This release provides several new features, including a major Cbor configuration rework.
It uses Kotlin 2.0.20 by default.

Cbor feature set for COSE compliance

This change brings a lot of features to the CBOR format, namely:

• Serial Labels — see @CborLabel annotation and preferCborLabelsOverNames flag.
• Tagging of keys and values — see encode*Tags and verify*Tags set of flags
• Definite length encoding — see useDefiniteLengthEncoding. This flag affects object encoding, since decoding of arrays with definite lenghts is automatically supported.
• Option to globally prefer major type 2 for byte array encoding — see alwaysUseByteString flag.

Since there are quite a lot of flags now, they were restructured to a separate CborConfiguration class, similarly to JsonConfiguration.
It is possible to retrieve this configuration from CborEncoder/CborDecoder interfaces in your custom serializers (see their documentation for details).

All of these features make it possible to serialize and parse COSE-compliant CBOR, for example, ISO/IEC 18013-5:2021-compliant mobile driving license data.
In case you want to make use of them, there is a predefined Cbor.CoseCompliant instance.
However, some canonicalization steps (such as sorting keys) still need to be performed manually.

This functionality was contributed to us by Bernd Prünster.

Keeping generated serializers

One of the most requested features for serialization plugin was to continue to generate a serializer even if a custom one is specified for the class.
It allows using a plugin-generated serializer in a fallback or delegate strategy, accessing type structure via descriptor, using default serialization behavior in inheritors that do not use custom serializers.

Starting with this release, you can specify the @KeepGeneratedSerializer annotation on the class declaration to instruct the plugin to continue generating the serializer.
In this case, the serializer will be accessible using the .generatedSerializer() function on the class's companion object.

This annotation is currently experimental. Kotlin 2.0.20 or higher is required for this feature to work.

You can check out the examples in the documentation and in the PRs: #​2758, #​2669.

Serializer for kotlin.uuid.Uuid

Kotlin 2.0.20 added a common class to represent UUIDs in a multiplatform code.
kotlinx.serialization 1.7.2 provides a corresponding Uuid.serializer() for it, making it possible to use it in @Serializable classes.
Note that for now, serializer should be provided manually with @Contextual annotation.
Plugin will be able to automatically insert Uuid serializer in Kotlin 2.1.0.

See more details in the corresponding PR.

Other bugfixes and improvements

• Prohibited using of zero and negative field numbers in ProtoNumber (#​2766)
• Improve readability of protobuf decoding exception messages (#​2768) (thanks to xiaozhikang0916)
• docs(serializers): Fix grammatical errors (#​2779) (thanks to jamhour1g)
• Fixed VerifyError after ProGuard optimization (#​2728)
• Add wasm-wasi target to Okio integration (#​2727)

v1.7.1

==================

This is a bugfix release that aims to fix missing kotlinx-serialization-hocon artifact.
It also contains experimental integration with kotlinx-io library.
Kotlin 2.0.0 is used by default.

Fixed HOCON publication

Sadly, 1.7.0 release was published incomplete: kotlinx-serialization-hocon artifact is missing from 1.7.0 and 1.7.0-RC releases.
This release fixes this problem and now kotlinx-serialization-hocon is available again with 1.7.1 version.
No other changes were made to this artifact. Related ticket: #​2717.

Add integration with a kotlinx-io library

kotlinx-io is an official multiplatform library that provides basic IO primitives, similar to Okio.
kotlinx.serialization integration is now available in a separate artifact, located at the kotlinx-serialization-json-io coordinates.
Integration artifact provides functions similar to existing Okio integration: encodeToSink, decodeFromSource, and decodeSourceToSequence.
Check out the PR for more details.

Other bugfixes

• Prohibited use of elements other than JsonObject in JsonTransformingSerializer with polymorphic serialization (#​2715)

v1.7.0

==================

This release contains all of the changes from 1.7.0-RC and is compatible with Kotlin 2.0.
Please note that for reasons explained in the 1.7.0-RC changelog, it may not be possible to use it with the Kotlin 1.9.x
compiler plugin. Yet, it is still fully backwards compatible with previous versions.

The only difference with 1.7.0-RC is that classDiscriminatorMode property in JsonBuilder is marked as experimental,
as it should have been when it was introduced (#​2680).

v1.10.2

Compare Source

• Fixed the kotlinx-coroutines-debug JAR file including the module-info.class file twice, resulting in failures in various tooling (#​4314). Thanks, @​RyuNen344!
• Fixed Flow.stateIn hanging when the scope is cancelled in advance or the flow is empty (#​4322). Thanks, @​francescotescari!
• Improved handling of dispatcher failures in .limitedParallelism (#​4330) and during flow collection (#​4272).
• Fixed runBlocking failing to run its coroutine to completion in some cases if its JVM thread got interrupted (#​4399).
• Small tweaks, fixes, and documentation improvements.

v1.10.1

Compare Source

• Fixed binary incompatibility introduced for non-JVM targets in #​4261 (#​4309).

v1.10.0

Compare Source

• Kotlin was updated to 2.1.0 (#​4284).
• Introduced Flow.any, Flow.all, and Flow.none (#​4212). Thanks, @​CLOVIS-AI!
• Reorganized kotlinx-coroutines-debug and kotlinx-coroutines-core code to avoid a split package between the two artifacts (#​4247). Note that directly referencing kotlinx.coroutines.debug.AgentPremain must now be replaced with kotlinx.coroutines.debug.internal.AgentPremain. Thanks, @​sellmair!
• No longer shade byte-buddy in kotlinx-coroutines-debug, reducing the artifact size and simplifying the build configuration of client code. Thanks, @​sellmair!
• Fixed NullPointerException when using Java-deserialized kotlinx-coroutines-core exceptions (#​4291). Thanks, @​AlexRiedler!
• Properly report exceptions thrown by CoroutineDispatcher.dispatch instead of raising internal errors (#​4091). Thanks, @​zuevmaxim!
• Fixed a bug that delayed scheduling of a Dispatchers.Default or Dispatchers.IO task after a yield() in rare scenarios (#​4248).
• Fixed a bug that prevented the main() coroutine on Wasm/WASI from executing after a delay() call in some scenarios (#​4239).
• Fixed scheduling of runBlocking tasks on Kotlin/Native that arrive after the runBlocking block was exited (#​4245).
• Fixed some terminal Flow operators sometimes resuming without taking cancellation into account (#​4254). Thanks, @​jxdabc!
• Fixed a bug on the JVM that caused coroutine-bound ThreadLocal values not to get cleaned when using non-CoroutineDispatcher continuation interceptors (#​4296).
• Small tweaks, fixes, and documentation improvements.

v1.9.0

Compare Source

Features

• Wasm/WASI target support (#​4064). Thanks, @​igoriakovlev!
• limitedParallelism now optionally accepts the name of the dispatcher view for easier debugging (#​4023).
• No longer initialize Dispatchers.IO on the JVM when other standard dispatchers are accessed (#​4166). Thanks, @​metalhead8816!
• Introduced the Flow<T>.chunked(size: Int): Flow<List<T>> operator that groups emitted values into groups of the given size (#​1290).
• Closeable dispatchers are instances of AutoCloseable now (#​4123).

Fixes

• Calling hasNext on a Channel's iterator is idempotent (#​4065). Thanks, @​gitpaxultek!
• CoroutineScope() created without an explicit dispatcher uses Dispatchers.Default on Native (#​4074). Thanks, @​whyoleg!
• Fixed a bug that prevented non-Android Dispatchers.Main from initializing when the Firebase dependency is used (#​3914).
• Ensured a more intuitive ordering of tasks in runBlocking (#​4134).
• Forbid casting a Mutex to Semaphore (#​4176).
• Worked around a stack overflow that may occur when calling asDeferred on a Future many times (#​4156).

Deprecations and promotions

• Advanced the deprecation levels for BroadcastChannel-based API (#​4197).
• Advanced the deprecation levels for the old kotlinx-coroutines-test API (#​4198).
• Deprecated Job.cancelFutureOnCompletion (#​4173).
• Promoted CoroutineDispatcher.limitedParallelism to stable (#​3864).
• Promoted CoroutineStart.ATOMIC from ExperimentalCoroutinesApi to DelicateCoroutinesApi (#​4169).
• Promoted CancellableContinuation.resume with an onCancellation lambda to stable, providing extra arguments to the lambda (#​4088).
• Marked the classes and interfaces that are not supposed to be inherited from with the new InternalForInheritanceCoroutinesApi opt-in (#​3770).
• Marked the classes and interfaces inheriting from which is not stable with the new ExperimentalForInheritanceCoroutinesApi opt-in (#​3770).

Other

• Kotlin was updated to 2.0 (#​4137).
• Reworked the documentation for CoroutineStart and Channel-based API (#​4147, #​4148, #​4167). Thanks, @​globsterg!
• Simplified the internal implementation of Job (#​4053).
• Small tweaks, fixes, and documentation improvements.

v2.0.8

Compare Source

v2.0.6

Compare Source

Changed

• Fix: Issue with files not being closed by RollingFileLogWriter
• Update: cinterop definitions used by OSLogWriter now have a kermit prefix to avoid conflicts with other libraries
• New: Added an example of a test to sample-production

v2.0.5

Compare Source

Changed

• Added kermit-io module, which contains the RollingFileLogWriter. This is a log writer that writes to a file with rolling logs.
• Updating OSLogWriter to take in three optional parameters to configure OSLog, and to enable/disable public logging
• Updating the WASM Implementation to match newest recommendations
• Updating kotlin version to 2.0.21
• Updating logThrowable to call throwable.stackTraceToString() instead of throwable.getStackTrace().joinToString("\n")

v2.0.4

Compare Source

Changed

• Added ChunkedLogWriter. This LogWriter can be used to wrap existing LogWriters and break their output into defined sizes. This is useful if your LogWriter outputs to something which limits message length (such as Logcat) (#​396 thanks @​psh)

Logger.setLogWriters(platformLogWriter().chunked(maxMessageLength = 4000))